home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / NVRAM.a < prev    next >
Text File  |  1996-05-01  |  3KB  |  142 lines
  1. ;
  2. ;    File:        NVRAM.a
  3. ;
  4. ;    Contains:    NVRAM FPI data structures and function prototypes 
  5. ;
  6. ;    Version:    Technology:    
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__NVRAM__') = 'UNDEFINED' THEN
  19. __NVRAM__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__KERNEL__') = 'UNDEFINED' THEN
  25.     include 'Kernel.a'
  26.     ENDIF
  27.     IF &TYPE('__OSUTILS__') = 'UNDEFINED' THEN
  28.     include 'OSUtils.a'
  29.     ENDIF
  30.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  31.     include 'Errors.a'
  32.     ENDIF
  33.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  34. ;
  35. ;    NVRAM Error Return Code
  36. ;
  37.  
  38. NVRAMnoErr                        EQU        0
  39. NVRAMInvalidParm                EQU        -50
  40. NVRAMReadFailed                    EQU        -19
  41. NVRAMWriteFailed                EQU        -20
  42. NVRAMServiceFailed                EQU        -18
  43. NVRAMInstallFailed                EQU        -26
  44. ;
  45. ;    NVRAM Request Code
  46. ;
  47.  
  48. kNVRAMpramInitMsg                EQU        1
  49. kNVRAMpramReadMsg                EQU        2                    ; This include read access to System Parameters and XPRAM 
  50. kNVRAMpramWriteMsg                EQU        3                    ; This include write access to System Parameters and XPRAM
  51. kNVRAMrpramReadMsg                EQU        4
  52. kNVRAMrpramWriteMsg                EQU        5
  53. kNVRAMReadMsg                    EQU        6
  54. kNVRAMWriteMsg                    EQU        7
  55. kNVRAMOpenFirmwareReadMsg        EQU        8
  56. kNVRAMOpenFirmwareWriteMsg        EQU        9
  57. kNVRAMNameRegistryReadMsg        EQU        10
  58. kNVRAMNameRegistryWriteMsg        EQU        11
  59. kNVRAMRqstLimit                    EQU        12
  60. ;
  61. ;    Function    :    NVRAMFPIInit
  62. ;    
  63. ;    Description    :    Find the Object Id property in the family-tree
  64. ;                    This is essential for message passing between FPI and kernel server task.
  65. ;                    This is the main entry for the NVRAMFPI library, and will be called when
  66. ;                    FPI library is loaded by the CFM.
  67. ;
  68. ;
  69. ; extern OSStatus NVRAMFPIInit(void )
  70. ;
  71.     IF GENERATINGCFM THEN
  72.         IMPORT_CFM_FUNCTION NVRAMFPIInit
  73.     ENDIF
  74.  
  75. ;
  76. ;    Function    :    NVRAMAccessSync
  77. ;    
  78. ;    Description    :    This is common entry point for synchronous access to NVRAM hardware.
  79. ;                    This is an export in the NVRAMFPI library.
  80. ;
  81. ;
  82. ; extern OSStatus NVRAMAccessSync(UInt32 offset, Byte *accessData, ByteCount sizeofAccess, UInt32 typeOfRequest)
  83. ;
  84.     IF GENERATINGCFM THEN
  85.         IMPORT_CFM_FUNCTION NVRAMAccessSync
  86.     ENDIF
  87.  
  88. ;
  89. ;    Function    :    NVRAMAccessAsync
  90. ;    
  91. ;    Description    :    This is common entry point for asynchronous access to NVRAM hardware
  92. ;                    This is an export in the NVRAMFPI library.
  93. ;
  94. ;
  95. ; extern OSStatus NVRAMAccessAsync(UInt32 offset, Byte *accessData, ByteCount sizeofAccess, void *someTypeofNotification, UInt32 typeOfRequest, ByteCount *replySize, MessageID *msgID)
  96. ;
  97.     IF GENERATINGCFM THEN
  98.         IMPORT_CFM_FUNCTION NVRAMAccessAsync
  99.     ENDIF
  100.  
  101. ;
  102. ;    Test APIs or SPIs
  103. ;
  104. ;
  105. ; pascal OSErr myInitUtil(void )
  106. ;
  107.     IF GENERATINGCFM THEN
  108.         IMPORT_CFM_FUNCTION myInitUtil
  109.     ENDIF
  110.  
  111. ;
  112. ; pascal SysPPtr myGetSysPPtr(void )
  113. ;
  114.     IF GENERATINGCFM THEN
  115.         IMPORT_CFM_FUNCTION myGetSysPPtr
  116.     ENDIF
  117.  
  118. ;
  119. ; pascal OSErr myWriteParam(void )
  120. ;
  121.     IF GENERATINGCFM THEN
  122.         IMPORT_CFM_FUNCTION myWriteParam
  123.     ENDIF
  124.  
  125. ;
  126. ; pascal OSErr myWriteXPRAM(UInt32 offset, Byte *accessdata, ByteCount numberOfBytes)
  127. ;
  128.     IF GENERATINGCFM THEN
  129.         IMPORT_CFM_FUNCTION myWriteXPRAM
  130.     ENDIF
  131.  
  132. ;
  133. ; pascal OSErr myReadXPRAM(UInt32 offset, Byte *accessdata, ByteCount numberOfBytes)
  134. ;
  135.     IF GENERATINGCFM THEN
  136.         IMPORT_CFM_FUNCTION myReadXPRAM
  137.     ENDIF
  138.  
  139.     ENDIF
  140.     ENDIF ; __NVRAM__ 
  141.  
  142.